Node / meshtastic / Meshtastic-Android / files / core / model / src / commonMain / kotlin / org / meshtastic / core / model / MeshBeaconOffer.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.core.model

Tff7b72import T7ee787okio.ByteString.Companion.decodeBase64

Tff7b72import T7ee787okio.ByteString.Companion.toByteString

Tff7b72import T7ee787org.meshtastic.proto.MeshBeacon

T8b949e/**

* A received Mesh Beacon invitation — an advisory, zero-hop advertisement from another mesh offering a channel to join.

* Beacons are unsigned and originate from nodes outside the local NodeDB, so this is deliberately not a

* message/contact; it lives in the Discovery surface instead.

*

* @param fromNodeNum The node that broadcast the beacon (informational only — beacons are unsigned).

* @param beacon The decoded advertisement, carrying the display [message][MeshBeacon.message] and the join offer.

* @param snr Signal-to-noise ratio of the received beacon packet, in dB, or null when the radio reported none.

* @param rssi Received signal strength of the beacon packet, in dBm, or null when the radio reported none.

*/

Tff7b72data Tff7b72class T56d364MeshBeaconOfferTb4b4b4(

Tff7b72val Te6edf3fromNodeNumTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72val Te6edf3beaconTb4b4b4: Te6edf3MeshBeaconTb4b4b4,

Tff7b72val Te6edf3snrTb4b4b4: Tffa657Float? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3rssiTb4b4b4: Tffa657Int? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4) Tb4b4b4{

T8b949e/** Stable identity for dedup/dismiss: a given sender advertising a given channel is one standing invitation. */

Tff7b72val Te6edf3keyTb4b4b4: Tffa657String

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Ta5d6ff"Tffd700$Te6edf3fromNodeNumTa5d6ff:Tffd700${Te6edf3beaconTb4b4b4.Te6edf3offer_channelTff7b72?.Te6edf3nameTb4b4b4.Te6edf3orEmptyTb4b4b4(Tb4b4b4)Tffd700}Ta5d6ff"

Tff7b72val Te6edf3messageTb4b4b4: Tffa657String

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3beaconTb4b4b4.Te6edf3message

Tff7b72val Te6edf3channelNameTb4b4b4: Tffa657String?

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3beaconTb4b4b4.Te6edf3offer_channelTff7b72?.Te6edf3nameTff7b72?.Te6edf3ifBlank Tb4b4b4{ Tff7b72null Tb4b4b4}

T8b949e/**

* Serializes to a single-line record `fromNodeNum|snr|rssi|<base64 MeshBeacon>` for lightweight prefs persistence.

* The base64 alphabet never contains `|`, so the delimiter is unambiguous.

*/

Tff7b72fun Td2a8ffencodeTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

Tff7b72val Te6edf3beaconB64 Tff7b72= Te6edf3MeshBeaconTb4b4b4.Te6edf3ADAPTERTb4b4b4.Te6edf3encodeTb4b4b4(Te6edf3beaconTb4b4b4)Tb4b4b4.Te6edf3toByteStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3base64Tb4b4b4(Tb4b4b4)

Tff7b72return Ta5d6ff"Tffd700$Te6edf3fromNodeNumTa5d6ff|Tffd700$Te6edf3snrTa5d6ff|Tffd700$Te6edf3rssiTa5d6ff|Tffd700$Te6edf3beaconB64Ta5d6ff"

Tb4b4b4}

Tff7b72companion Tff7b72object Tb4b4b4{

Tff7b72private Tff7b72const Tff7b72val Te6edf3RECORD_FIELD_COUNT Tff7b72= T79c0ff4

T8b949e/**

* Inverse of [encode]; returns null for a structurally malformed record (wrong field count, unparseable node

* number, or an undecodable beacon payload). An unparseable snr or rssi falls back to absent — they are

* non-critical display metrics, not identity, so a bad numeric there does not discard an otherwise-valid

* invitation. An absent value encodes as `null`, which [String.toFloatOrNull]/[String.toIntOrNull] round-trip

* back to null.

*/

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffReturnCountTa5d6ff"Tb4b4b4)

Tff7b72fun Td2a8ffdecodeTb4b4b4(Te6edf3recordTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3MeshBeaconOffer? Tb4b4b4{

Tff7b72val Te6edf3parts Tff7b72= Te6edf3recordTb4b4b4.Te6edf3splitTb4b4b4(Ta5d6ff'|'Tb4b4b4, Te6edf3limit Tff7b72= Te6edf3RECORD_FIELD_COUNTTb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3partsTb4b4b4.Te6edf3size Tff7b72!Tff7b72= Te6edf3RECORD_FIELD_COUNTTb4b4b4) Tff7b72return Tff7b72null

Tff7b72val Te6edf3node Tff7b72= Te6edf3partsTff7b72[T79c0ff0Tff7b72]Tb4b4b4.Te6edf3toIntOrNullTb4b4b4(Tb4b4b4) Tff7b72?: Tff7b72return Tff7b72null

Tff7b72val Te6edf3beaconBytes Tff7b72= Te6edf3partsTb4b4b4.Te6edf3lastTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3decodeBase64Tb4b4b4(Tb4b4b4)Tff7b72?.Te6edf3toByteArrayTb4b4b4(Tb4b4b4) Tff7b72?: Tff7b72return Tff7b72null

Tff7b72val Te6edf3beacon Tff7b72= Te6edf3runCatching Tb4b4b4{ Te6edf3MeshBeaconTb4b4b4.Te6edf3ADAPTERTb4b4b4.Te6edf3decodeTb4b4b4(Te6edf3beaconBytesTb4b4b4) Tb4b4b4}Tb4b4b4.Te6edf3getOrNullTb4b4b4(Tb4b4b4) Tff7b72?: Tff7b72return Tff7b72null

Tff7b72return Te6edf3MeshBeaconOfferTb4b4b4(Te6edf3nodeTb4b4b4, Te6edf3beaconTb4b4b4, Te6edf3partsTff7b72[T79c0ff1Tff7b72]Tb4b4b4.Te6edf3toFloatOrNullTb4b4b4(Tb4b4b4)Tb4b4b4, Te6edf3partsTff7b72[T79c0ff2Tff7b72]Tb4b4b4.Te6edf3toIntOrNullTb4b4b4(Tb4b4b4)Tb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tb4b4b4}